<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>pykodio: pkPlayback.pkPlayback Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">pykodio
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespacepkPlayback.html">pkPlayback</a></li><li class="navelem"><a class="el" href="classpkPlayback_1_1pkPlayback.html">pkPlayback</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="classpkPlayback_1_1pkPlayback-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">pkPlayback.pkPlayback Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a1711e788f9f1136ce641c5017f60cab8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1711e788f9f1136ce641c5017f60cab8"></a>
def&#160;</td><td class="memItemRight" valign="bottom"><b>__init__</b></td></tr>
<tr class="separator:a1711e788f9f1136ce641c5017f60cab8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a155668c6a4af9cce5ac043a9b255bb82"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpkPlayback_1_1pkPlayback.html#a155668c6a4af9cce5ac043a9b255bb82">play</a></td></tr>
<tr class="separator:a155668c6a4af9cce5ac043a9b255bb82"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a54afb7f6bc627555819b9d159550ee57"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpkPlayback_1_1pkPlayback.html#a54afb7f6bc627555819b9d159550ee57">pause</a></td></tr>
<tr class="separator:a54afb7f6bc627555819b9d159550ee57"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a416dcff4d9acfd132deafa4d67e8c257"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpkPlayback_1_1pkPlayback.html#a416dcff4d9acfd132deafa4d67e8c257">stop</a></td></tr>
<tr class="separator:a416dcff4d9acfd132deafa4d67e8c257"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9058a9a4a5740c93665345154b357a27"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpkPlayback_1_1pkPlayback.html#a9058a9a4a5740c93665345154b357a27">next</a></td></tr>
<tr class="separator:a9058a9a4a5740c93665345154b357a27"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f7f84cc74ab2cef4dc6003c16027603"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpkPlayback_1_1pkPlayback.html#a3f7f84cc74ab2cef4dc6003c16027603">previous</a></td></tr>
<tr class="separator:a3f7f84cc74ab2cef4dc6003c16027603"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a163279f9a33c2b1f0d61251169441835"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpkPlayback_1_1pkPlayback.html#a163279f9a33c2b1f0d61251169441835">rewind</a></td></tr>
<tr class="separator:a163279f9a33c2b1f0d61251169441835"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7763910e46af56f752eeff3926b728b3"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpkPlayback_1_1pkPlayback.html#a7763910e46af56f752eeff3926b728b3">forward</a></td></tr>
<tr class="separator:a7763910e46af56f752eeff3926b728b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a57fd0739d1d7f3c3f63dac222e23013b"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpkPlayback_1_1pkPlayback.html#a57fd0739d1d7f3c3f63dac222e23013b">seek</a></td></tr>
<tr class="separator:a57fd0739d1d7f3c3f63dac222e23013b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a195653a69462a57d596b3b77deb38b9c"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpkPlayback_1_1pkPlayback.html#a195653a69462a57d596b3b77deb38b9c">go_to_song</a></td></tr>
<tr class="separator:a195653a69462a57d596b3b77deb38b9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae71bd9fbc5b307093d68760a5e5b33b8"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpkPlayback_1_1pkPlayback.html#ae71bd9fbc5b307093d68760a5e5b33b8">clear</a></td></tr>
<tr class="separator:ae71bd9fbc5b307093d68760a5e5b33b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3043a4fa474d8c322e7e691d19535235"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpkPlayback_1_1pkPlayback.html#a3043a4fa474d8c322e7e691d19535235">set_queue</a></td></tr>
<tr class="separator:a3043a4fa474d8c322e7e691d19535235"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ea242d99b26bd0501014b95a40fb0a1"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpkPlayback_1_1pkPlayback.html#a9ea242d99b26bd0501014b95a40fb0a1">get_current_queue</a></td></tr>
<tr class="separator:a9ea242d99b26bd0501014b95a40fb0a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a7c86a5a60ae79467435237175be7bb99"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7c86a5a60ae79467435237175be7bb99"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>play_stack_cursor</b></td></tr>
<tr class="separator:a7c86a5a60ae79467435237175be7bb99"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><pre class="fragment">General playback utility for pykodio.
Uses phonon for playback.
</pre> </div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ae71bd9fbc5b307093d68760a5e5b33b8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def pkPlayback.pkPlayback.clear </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<pre class="fragment">Empty Phonon's MediaObject queue and playing song</pre> 
</div>
</div>
<a class="anchor" id="a7763910e46af56f752eeff3926b728b3"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def pkPlayback.pkPlayback.forward </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<pre class="fragment">Seek gradually the playing song forward
--This method should be place in a loop
</pre> 
</div>
</div>
<a class="anchor" id="a9ea242d99b26bd0501014b95a40fb0a1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def pkPlayback.pkPlayback.get_current_queue </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<pre class="fragment">Return the current queue for testing purpose </pre> 
</div>
</div>
<a class="anchor" id="a195653a69462a57d596b3b77deb38b9c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def pkPlayback.pkPlayback.go_to_song </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>songPosition</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<pre class="fragment">Set new playlist starting by the song at songPosition

song_position: songPositionInStack(song_group, song_index_in_group)
</pre> 
</div>
</div>
<a class="anchor" id="a9058a9a4a5740c93665345154b357a27"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def pkPlayback.pkPlayback.next </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<pre class="fragment">Skip to next song in the Phonon MediaObject's queue </pre> 
</div>
</div>
<a class="anchor" id="a54afb7f6bc627555819b9d159550ee57"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def pkPlayback.pkPlayback.pause </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<pre class="fragment">Pause the playback </pre> 
</div>
</div>
<a class="anchor" id="a155668c6a4af9cce5ac043a9b255bb82"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def pkPlayback.pkPlayback.play </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<pre class="fragment">Start the playback </pre> 
</div>
</div>
<a class="anchor" id="a3f7f84cc74ab2cef4dc6003c16027603"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def pkPlayback.pkPlayback.previous </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<pre class="fragment">Returns to the begining of the current source, or to the previous
one if the song started less than _PREVIOUS_THRESHOLD ago
</pre> 
</div>
</div>
<a class="anchor" id="a163279f9a33c2b1f0d61251169441835"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def pkPlayback.pkPlayback.rewind </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<pre class="fragment">Seek gradually the playing song backward
--This method should be place in a loop
</pre> 
</div>
</div>
<a class="anchor" id="a57fd0739d1d7f3c3f63dac222e23013b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def pkPlayback.pkPlayback.seek </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>time</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<pre class="fragment">Seek the playing song at a specified time
--For better accuracy, use (insertName) slider
</pre> 
</div>
</div>
<a class="anchor" id="a3043a4fa474d8c322e7e691d19535235"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def pkPlayback.pkPlayback.set_queue </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>paths_of_songs_to_enqueue</em> = <code>[]</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<pre class="fragment">Set Phonon's MediaObject queue to songs_to_enqueue list </pre> 
</div>
</div>
<a class="anchor" id="a416dcff4d9acfd132deafa4d67e8c257"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def pkPlayback.pkPlayback.stop </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<pre class="fragment">Stop the playback, clear the playlist, clear current source </pre> 
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>pkPlayback.py</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Nov 20 2012 20:14:38 for pykodio by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.2
</small></address>
</body>
</html>
